Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Convert rST to MyST (Markdown) #11145

Merged
merged 33 commits into from
Dec 23, 2024

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Dec 12, 2024

This PR migrates the existing documentation from reStructuredText to MyST Markdown, a flavour of Markdown extended for use with Sphinx.

  • Add .md template to gitignore
  • Upgrade myst-parser to 3.0.1
  • Converts .rst docs into .md, preserving content and formatting
  • Update filename references to docs from .rst to .md
  • In front-end code, update class/function definition references to documentation
    • e.g. :ref: engine_args -> [engine-args](#engine-args)

Closes #10427

Signed-off-by: Rafael Vasquez <[email protected]>
Copy link

👋 Hi! Thank you for contributing to the vLLM project.
Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Dec 12, 2024
Copy link

mergify bot commented Dec 12, 2024

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @rafvasq.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Dec 12, 2024
@DarkLight1337 DarkLight1337 self-assigned this Dec 13, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@mergify mergify bot added the ci/build label Dec 16, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
@mergify mergify bot added the frontend label Dec 17, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@mergify mergify bot removed the needs-rebase label Dec 18, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq marked this pull request as ready for review December 18, 2024 20:32
@DarkLight1337
Copy link
Member

The links for code examples (e.g. https://vllm--11145.org.readthedocs.build/en/11145/getting_started/examples/api_client.html) are also broken.

Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq
Copy link
Contributor Author

rafvasq commented Dec 23, 2024

Nice catch @DarkLight1337, I addressed the output links in the examples.

@DarkLight1337
Copy link
Member

Hmm, I see that the Examples links are still missing the GitHub icon. Any way to fix that?

Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq
Copy link
Contributor Author

rafvasq commented Dec 23, 2024

Hmm, I see that the Examples links are still missing the GitHub icon. Any way to fix that?

Using markdown's automatic links <http://example.com/> instead of [example](http://example.com/) solved it. The style matches the current docs now. ✅

@DarkLight1337
Copy link
Member

The links in Compatibility Matrix are broken as well.

@DarkLight1337
Copy link
Member

Maybe make the warning in https://vllm--11145.org.readthedocs.build/en/11145/usage/performance.html#preemption a code block?

@DarkLight1337
Copy link
Member

Suggestion: Add inline code blocks for the last section of https://vllm--11145.org.readthedocs.build/en/11145/usage/usage_stats.html#opt-out-of-usage-stats-collection

@DarkLight1337
Copy link
Member

I have looked through the rest of the pages and they look fine. Nice work!

Copy link

mergify bot commented Dec 23, 2024

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @rafvasq.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Dec 23, 2024
@mergify mergify bot removed the needs-rebase label Dec 23, 2024
@DarkLight1337
Copy link
Member

Looks like LoRA ref is broken.

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) December 23, 2024 18:47
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Dec 23, 2024
@DarkLight1337
Copy link
Member

Let's get this merged!

@DarkLight1337 DarkLight1337 merged commit 32aa205 into vllm-project:main Dec 23, 2024
79 of 82 checks passed
ayylemao pushed a commit to ayylemao/vllm that referenced this pull request Dec 24, 2024
BKitor pushed a commit to BKitor/vllm that referenced this pull request Dec 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/build documentation Improvements or additions to documentation frontend ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: Migrate to Markdown
4 participants